|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.team.core.sync.LocalSyncElement
Note: This class/interface is part of an interim API that is still under
development and expected to change significantly before reaching stability.
It is being made available at this early stage to solicit feedback from pioneering
adopters on the understanding that any code that uses this API will almost
certainly be broken (repeatedly) as the API evolves.
A standard abstract class that provides implementations for ILocalSyncElement
methods.
Field Summary |
Fields inherited from interface org.eclipse.team.core.sync.ILocalSyncElement |
ADDITION, AUTOMERGE_CONFLICT, CHANGE, CHANGE_MASK, CONFLICTING, DELETION, DIRECTION_MASK, GRANULARITY_CONTENTS, GRANULARITY_CONTENTS_IGNORE_WHITESPACE, GRANULARITY_TIMESTAMP, IN_SYNC, INCOMING, MANUAL_CONFLICT, OUTGOING, PSEUDO_CONFLICT |
Constructor Summary | |
LocalSyncElement()
|
Method Summary | |
abstract ILocalSyncElement |
create(IResource local,
IRemoteResource base,
Object data)
Creates a client specific sync element from a local and base resources. |
boolean |
equals(Object other)
|
protected abstract Object |
getData()
Client data that is passed to every create() call. |
String |
getName()
Answer a string that describes the simple name of the sync node, which is suitable for display to a user. |
int |
getSyncKind(int granularity,
IProgressMonitor progress)
Performs a synchronization calculation on the given element based on the local and base resources. |
boolean |
isContainer()
Answer if the sync node is a container and may have children. |
protected abstract boolean |
isIgnored(IResource resource)
Client can decide is a specific element should be ignored from this sync element's children. |
ILocalSyncElement[] |
members(IProgressMonitor monitor)
Answers and array of ILocalSyncElement elements that are immediate
children of this sync element, in no particular order. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.team.core.sync.ILocalSyncElement |
getBase, getLocal |
Constructor Detail |
public LocalSyncElement()
Method Detail |
public abstract ILocalSyncElement create(IResource local, IRemoteResource base, Object data)
null
and should be
intialized by the client if available.
local
- the local resource in the workbench. Will never be null
.base
- the base resource, may me null
.data
- client specific data.
protected abstract Object getData()
create()
call.
protected abstract boolean isIgnored(IResource resource)
resource
- the resource to be queried.
true
if this element should be ignored and not considered an
immediate child of this element, and false
otherwise.public int getSyncKind(int granularity, IProgressMonitor progress)
ILocalSyncElement
getSyncKind
in interface ILocalSyncElement
granularity
- the granularity at which the elements of this sync element
should be compared. On of GRANULARITY_TIMESTAMP
, or
GRANULARITY_CONTENTS
.progress
- a progress monitor to indicate the duration of the operation, or
null
if progress reporting is not required.
public String getName()
ILocalSyncElement
getName
in interface ILocalSyncElement
public boolean isContainer()
ILocalSyncElement
isContainer
in interface ILocalSyncElement
true
if the remote resource is a container, and
false
if it is not.public ILocalSyncElement[] members(IProgressMonitor monitor) throws TeamException
ILocalSyncElement
ILocalSyncElement
elements that are immediate
children of this sync element, in no particular order. The returned sync nodes are
a combination of the nodes represented by the sync element (e.g. local, base, remote).
members
in interface ILocalSyncElement
monitor
- a progress monitor to indicate the duration of the operation, or
null
if progress reporting is not required.
TeamException
public boolean equals(Object other)
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |